/*
 * The MIT License
 *
 * Copyright 2015 CloudBees, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package org.jenkinsci.plugins.workflow.job;

import hudson.model.JobProperty;
import hudson.security.ACL;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

/**
 * Job property which can specially affect behavior of the project.
 */
public abstract class WorkflowJobProperty extends JobProperty<WorkflowJob> {

    /**
     * Allows a property to control permissions related to the job.
     */
    public @Nonnull ACL decorateACL(@Nonnull ACL acl) {
        return acl;
    }

    /**
     * Allows a property to control whether {@link WorkflowJob#isBuildable}.
     * @return a value, or null to have no effect
     */
    public @CheckForNull Boolean isBuildable() {
        return null;
    }

}
